home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / spitfire / sfpckmsg.zip / SFPCKMSG.DOC < prev   
Text File  |  1993-01-23  |  10KB  |  198 lines
  1.                                 SFPCKMSG
  2.                                Version 1.3
  3.                   Copyright (C) by Mike Woltz, 1992-1993
  4.                           Buffalo Creek Software
  5.  
  6.  
  7.     INTRODUCTION
  8.     ------------
  9.  
  10.        SFPCKMSG is a companion utility designed for use with a SPITFIRE 
  11.     Bulletin Board System.  The purpose of SFPCKMSG is to pack the
  12.     SPITFIRE message base outside of SPITFIRE.  It can be used from
  13.     the DOS command line or can be set up to run as an event in SF.BAT.
  14.     SFPCKMSG is written by SPITFIRE author, Mike Woltz, in Turbo Assembler 
  15.     for maximum speed while requiring very little disk space.
  16.  
  17.  
  18.     DISTRIBUTION PACKAGE
  19.     --------------------
  20.       
  21.       When decompressed, the distribution package, SFPCKMSG.ZIP, should
  22.     contain the following files:
  23.     
  24.        SFPCKMSG.DOC      - This documentation file
  25.        SFPCKMSG.COM      - Executable message packer file
  26.        FILE_ID.DIZ       - Text file containing program description
  27.        
  28.       You are free to distribute the SFPCKMSG program as long as it remains
  29.     unmodified and no fee is charged.  Sysops are free to post this and 
  30.     subsequent versions of SFPCKMSG on public Bulletin Board Systems as
  31.     long as no fee is charged to obtain the file.
  32.     
  33.     
  34.     COMMAND LINE PARAMETERS
  35.     -----------------------
  36.   
  37.        SFPCKMSG uses the following command line parameters to allow you to
  38.     define the criteria that will be used when packing your SPITFIRE
  39.     message conferences.
  40.  
  41.      /OLD=x     - Purge messages that are x days old!  The x is replaced with
  42.                   a numerical value to represent the number of days old a
  43.                   message must be before it is packed.  For instance, if
  44.                   /OLD=60 were used as a command line parameter for SFPCKMSG,
  45.                   any messages that were 60 days old or older would be
  46.                   removed from the message conference(s).
  47.                   
  48.      /POT       - Purge old thread messages!  If this parameter is not used,
  49.                   old message threads will remain intact.  /POT must be used
  50.                   with the /OLD=x parameter to define the number of days old
  51.                   a message thread must be in order to be purged.
  52.  
  53.      /POU       - Purge old unreceived messages!  If this parameter is not 
  54.                   used, old unreceived messages will remain intact and not
  55.                   be purged from the message conference.  /POU must be used
  56.                   with the /OLD=x parameter to define the number of days old
  57.                   an unreceived message must be in order to be purged.
  58.  
  59.      /ALL       - Pack all message conferences!  All other parameters that
  60.                   are defined for SFPCKMSG will be applied to all SPITFIRE
  61.                   message conferences during the packing process.
  62.  
  63.      /CONF12    - Pack message conference #12!  Allows you to specify a
  64.                   a specific message conference for packing.  This can
  65.                   be an valid number associated with a SPITFIRE message
  66.                   conference.  All other parameters that are defined for
  67.                   SFPCKMSG will be applied that this message conference
  68.                   during the packing process.
  69.  
  70.      /CONF3..8  - Pack message conferences #3 through #8!  Allows you to
  71.                   specify a range of message conferences for packing.  This
  72.                   can be any numbers that are representative of valid
  73.                   SPITFIRE message conference numbers.  All other parameters
  74.                   that are defined for SFPCKMSG will be applied that these
  75.                   message conferences during the packing process.
  76.                   the 
  77.  
  78.      /SIZE=x    - Purge all but the newest x messages!  The x is replaced
  79.                   with a numerical value to represent the maximum number
  80.                   of messages you wish to retain in the message conference.
  81.                   SFPCKMSG will purge the oldest messages up to the number
  82.                   you specify here.  For example, if /SIZE=200 were used,
  83.                   the newest 200 messages would remain in the message
  84.                   conference and the oldest messages in excess of 200 would
  85.                   purged.
  86.  
  87.      /PRM       - Purge received messages!  When this parameter is used
  88.                   then SFPCKMSG will purge all received messages (regardless
  89.                   of their age) which are not addressed to 'All'.
  90.   
  91.       All parameters are optional except that you MUST define which 
  92.     conference(s) are to be packed.  This can be done either by specifying 
  93.     all (/ALL), a specific message conference number (/CONF12), or a range 
  94.     of conference numbers(/CONF3..8).  However, it should be noted if the
  95.     parameter specifying the conference is the only parameter that is used,
  96.     the only function SFPCKMSG will perform in addition to packing messages
  97.     marked for deletion will be to reset the message threads.  Keeping
  98.     these guidelines in mind, the command line parameters for SFPCKMSG may
  99.     be used in any order and in any combination.
  100.  
  101.       A typical example of usage for SFPCKMSG might look like this:
  102.  
  103.      C>SFPCKMSG /OLD=45 /POT /POU /CONF3..8 /SIZE=300    
  104.  
  105.     Using this example, SFPCKMSG would pack any messages in SPITFIRE message
  106.     conferences 3, 4, 5, 6, 7, and 8 that were older than 45 days; including
  107.     any threads or unreceived messages that were older than 45 days.  In
  108.     addition, if any of those message conferences had more than 300 messages
  109.     that were newer than 45 days old, it would only keep the newest 300
  110.     messages; packing the oldest messages that exceeded the 300 message
  111.     limit specified in the /SIZE=300 parameter.
  112.  
  113.  
  114.     USAGE
  115.     -----
  116.  
  117.        SFPCKMSG must reside in the SPITFIRE home directory.  The SPITFIRE
  118.     home directory is defined as the directory where SFNODE.DAT and 
  119.     SFMCONF.DAT are located.  If these files can not be found, SFPCKMSG
  120.     will halt operation.
  121.        
  122.        SFPCKMSG can be used either from the DOS prompt or from within a
  123.     batch file.  A good example of the later, would be to set SFPCKMSG up
  124.     to run as a scheduled event from SPITFIRE, thereby automatically packing
  125.     your message conferences routinely.  If you require additional information
  126.     in regard to setting up SFPCKMSG as an event, refer to the SPITFIRE 
  127.     documentation.
  128.  
  129.     
  130.     MULTINODE CAPABILITY
  131.     --------------------
  132.     
  133.        If SFPCKMSG is used on a multinode SPITFIRE BBS, it will perform
  134.     certain safeguards.  When executed, SFPCKMSG will check SFWHOSON.DAT
  135.     to verify all nodes are free.  In the event, a node is use, SFPCKMSG
  136.     will continue to loop and check SFWHOSON.DAT every ten seconds until
  137.     no one is logged onto the BBS.  When all nodes are free, SFPCKMSG
  138.     will begin packing the message conference(s).  No caller will be
  139.     allowed to log on the BBS until SFPCKMSG has been completed.
  140.     
  141.     
  142.     SPECIAL NOTES REGARDING SFPCKMSG
  143.     --------------------------------
  144.     
  145.        SFPCKMSG does not build backup message base files.  In the event
  146.     that SFPCKMSG would fail, the message files are left intact.
  147.     
  148.        Anytime SFPCKMSG is ran, it will rebuild message threads.  This
  149.     is done regardless of what command line parameters are used when
  150.     executing SFPCKMSG.  This ensures the integrity of message threading.
  151.  
  152.     REGISTRATION
  153.     ------------
  154.  
  155.        SFPCKMSG is distributed under the shareware concept.  You may use
  156.     the files included within SFPCKMSG.ZIP for a trial period of thirty
  157.     days.  If you continue to use these programs beyond the thirty day
  158.     trial period a $1.00 registration fee is required.  Registration 
  159.     should be sent to:
  160.  
  161.                          Buffalo Creek Software
  162.                          ATTN: Mike Woltz
  163.                          913 39th Street
  164.                          West Des Moines, Iowa   50265
  165.  
  166.  
  167.     DISCLAIMER
  168.     ----------
  169.         
  170.        Mike Woltz and/or Buffalo Creek Software shall in no way be 
  171.     held responsible for any damage incurred while operating SFPCKMSG.
  172.     All responsibility lies with the user of the software.
  173.  
  174.        The documentation for SFPCKMSG is contributed by Jacque
  175.     Shipley and The Mother Board BBS.  The shareware version of
  176.     SPITFIRE and other SPITFIRE utilities are available for download
  177.     from:
  178.  
  179.          Buffalo Creek's BBS              The Mother Board BBS
  180.           Mike Woltz, Sysop               Jacque Shipley, Sysop
  181.            (515) 225-8496                    (515) 986-3464
  182.     38400/19200/9600/2400/1200 Baud      19200/9600/2400/1200 Baud
  183.  
  184.     REVISION 1.2 * 12-05-92 * SFPCKMSG has been revised to purge any
  185.     message which is absent a message body.  In other words, SFPCKMSG
  186.     purges any message discovered with a message header (who to, who
  187.     from, date, etc.) but without a message body to accompany the
  188.     message header.  Such a message cannot be entered via SPITFIRE,
  189.     however, it has been discovered that message import programs will on
  190.     occasion import such a message.
  191.  
  192.     REVISION 1.3 * 01-23-93 * Previously, SFPCKMSG would not purge
  193.     unreceived messages addressed to a specific individual (not 'All')
  194.     regardless of their age.  The thought process (rightly) was for a 
  195.     board (such as Buffalo Creek's BBS) that doesn't participate in a
  196.     mail system, however, it was not practical for boards which participate
  197.     in a mail system.  Therefore, this has been changed.  Further, the
  198.     /PRM switch was added.